home *** CD-ROM | disk | FTP | other *** search
/ ADA Programming Guide / ADA Programming Guide.iso / ada_gwu / readme.dos < prev    next >
Text File  |  1996-01-30  |  14KB  |  315 lines
  1.  
  2. GW-Ada/Ed Distribution January 1994
  3.  
  4. Prof. Michael B. Feldman 
  5. Department of Electrical Engineering and Computer Science 
  6. The George Washington University 
  7. Washington, DC 20052
  8. (202) 994-5253 (voice) 
  9. (202) 994-5296 (fax) 
  10. mfeldman@seas.gwu.edu (Internet)
  11.  
  12. This distribution contains the source code and executables for GW-Ada/Ed, 
  13. which consists of the NYU Ada/Ed translator/interpreter system for DOS, 
  14. together with an integrated editor developed by Prof. Arthur Vargas Lopes 
  15. of the Pontifical University at Porto Alegre, Brazil. Lopes began his work on
  16. GW-Ada/Ed while he was a doctoral student at The George Washington
  17. University. There is also a very nice extended runtime facility, with
  18. interesting kinds of source tracing, developed by Charles Kann, a
  19. doctoral student at GW.
  20.  
  21. This program is free software; you can redistribute it and/or modify
  22. it under the terms of the GNU General Purpose License as published by
  23. the Free Software Foundation; either version 2 of the License, or
  24. (at your option) any later version. See relevant excerpts below.
  25.  
  26.  
  27. System Requirements
  28.  
  29.    IBM PC Compatible, 386 or 486, running MS-DOS or PC-DOS
  30.    at least 3.6 mb available extended memory
  31.    at least 5   mb free hard disk space
  32.  
  33.  
  34. Acquiring GW-Ada/Ed
  35.  
  36. GW-Ada/Ed is distributed in the form of .zip archives created by info-zip, 
  37. which is included in the distribution. 
  38.  
  39. The installable distribution consists of the following files:
  40.  
  41. -rw-r--r--   1 mfeldman users    1431491 Jan  9 16:24 binaries.zip
  42. -rw-r--r--   1 mfeldman users      34437 Jan  9 11:47 deptree.zip
  43. -rw-r--r--   1 mfeldman users      89467 Jan  9 11:24 pretty.zip
  44. -rw-r--r--   1 mfeldman users      10643 Jan 21 16:45 readme.dos
  45. -rw-r--r--   1 mfeldman users      24329 Jan 21 16:33 readme.nyu
  46. -rw-r--r--   1 mfeldman users      15999 May 14  1992 script11.zip
  47. -rw-r--r--   1 mfeldman users     371454 Jan  9 17:59 support.zip
  48. -rw-r--r--   1 mfeldman users      30581 Jan 21 16:45 unzip.exe
  49. -rw-r--r--   1 mfeldman users      32461 Jan 21 14:31 userman.dos
  50. -rw-r--r--   1 mfeldman users     202112 Jun 26  1993 zip19p1.zip
  51.  
  52. unzip.exe is a DOS program to unzip the zip archives; zip19p1.zip contains
  53. the entire info-zip distribution, including the zip program so that you 
  54. can create your own archives.
  55.  
  56. Userman.dos is a user-manual text file, describing the GW development
  57. environment. Readme.nyu is a text file with documentation on the NYU
  58. part of the system. Note that you do not have to use the GW-Ada/Ed
  59. integrated environment, but can execute the various parts of NYU Ada/Ed
  60. from the DOS command line, as described in the NYU instructions.
  61.  
  62. Binaries.zip is the archive containing the GW-Ada/Ed binaries; support.zip
  63. is the other files necessary to run the system, and several sets of useful
  64. demonstration programs. 
  65.  
  66. Now for some extra goodies: Pretty.zip is a pre-compiled version of the NASA
  67. PrettyPrinter, useful for formatting Ada programs nicely. Deptree.zip is
  68. a pre-compiled program for computing and displaying the dependency tree of
  69. a set of Ada compilation units. Finally, script11.zip is a public-domain
  70. program that will set up a file into which all your terminal input and
  71. output is copied. This is very useful for preparing assignments to turn in,
  72. or for reporting strange GW-Ada/Ed behavior to us.
  73.  
  74. If you are interested in the source code, which was compiled with the 
  75. Intel C compiler running under DOS 5.0, get the following files:
  76.  
  77. -rwxr-xr-x  1 mfeldman   103339 Jan 28 16:44 envsourc.zip
  78. -rwxr-xr-x  1 mfeldman   318490 Jan 28 16:45 hlpsourc.zip
  79. -rw-r--r--  1 mfeldman    58787 Jan 28 16:45 monsourc.zip
  80. -rw-r--r--  1 mfeldman   926615 Jan 28 16:46 nyusourc.zip
  81.  
  82. which contain the sources for the editor environment, help system,
  83. runtime monitor, and the slightly modified NYU Ada/Ed, respectively.
  84.  
  85. BE SURE TO USE BINARY MODE TO FTP AND DOWNLOAD ALL THE zip AND exe FILES!
  86.  
  87. When you un-archive the files (see the instructions below), you will
  88. find a user manual, userman.doc, describing the GW development
  89. environment, and a file readme.nyu file with documentation on the NYU
  90. part of the system. Note that you do not have to use the GW-Ada/Ed
  91. integrated environment, but can execute the various parts of NYU Ada/Ed
  92. from the DOS command line, as described in the NYU instructions.
  93.  
  94. Installing GW-Ada/Ed
  95.  
  96. Back up your distribution to floppy disks. Put binaries.zip on one
  97. diskette, and the other files, including support.zip, on another. 
  98.  
  99. It is very important to follow these instructions EXACTLY. Of the hundreds
  100. of e-mail messages we have received about GW-Ada/Ed, many report problems
  101. that are attributable simply to things being installed incorrectly.
  102.  
  103.     Assuming that:
  104.     
  105.     support.zip diskette is in drive B:
  106.     the target hard disk is C:
  107.  
  108.  
  109.     (1) Installation will create a directory called adaed containing
  110.         everything, so first change to the disk in which you wish this
  111.         directory to be installed.
  112.  
  113.     C:
  114.     cd c:\
  115.  
  116.     (2) Copy unzip.exe from the diskette to the hard drive
  117.  
  118.     copy b:\unzip.exe .
  119.  
  120.     (3) Unzip the first archive
  121.  
  122.     unzip b:\support.zip
  123.  
  124.         (4) change to the newly created adaed directory
  125.  
  126.         cd adaed
  127.  
  128.     (5) replace the first diskette with the second, and type
  129.  
  130.     c:\unzip b:\binaries.zip
  131.  
  132.     (6) Create a working directory for your Ada programs:
  133.  
  134.     mkdir c:\adaed\myprogs
  135.     
  136.     (7) Add c:\adaed to your DOS path, for example
  137.  
  138.     path=c:\adaed;c:\;c:\dos
  139.  
  140.     (8) create the adaed environment variable:
  141.  
  142.     set adaed=c:\adaed
  143.  
  144. NOTE: It is EXTREMELY important that the GW-Ada/Ed binaries (.exe files
  145. and all the help stuff) be at the top level of the adaed directory,
  146. and that the path and environment variable both point there. If this
  147. is not the case, you will get very strange error messages from the GW-Ada/Ed
  148. shell.
  149.  
  150. You might wish to add steps (7) and (8) to your autoexec.bat file, or
  151. create a separate setup.bat just to run when you need to use GW-Ada/Ed.
  152.  
  153.     (9) You are now ready to enter the GW-Ada/Ed environment.
  154.  
  155.     cd c:\adaed\myprogs
  156.     gwada
  157.  
  158. Once you enter the editor for the first time, you must select "new
  159. library" from the "options" menu to create a library for your Ada
  160. compilation output. Most of the other menu selections are pretty obvious
  161. and you are invited to explore them.
  162.  
  163. For more information on how to use GW-Ada/Ed select the "GW-Ada/Ed" option
  164. within the "Help" top menu item. For information on how to use the
  165. editor select the "Editor" option within the "Help" top menu item.
  166.  
  167. You can also use <F1> to get a screen on help on using the "hot keys" in
  168. the environment.
  169.  
  170. If you wish to run the Ada/Ed components adacomp, adabind, adaexec, and
  171. adalib, from the DOS command line, keep in mind that the GW-Ada/Ed
  172. environment has given the name "mylib" to your Ada library. You can
  173. create additional Ada libraries, but only "mylib" is accessible to the
  174. environment, and Ada/Ed can work with only one library at a time. See
  175. the NYU documentation for more details on this.
  176.  
  177. Additional Libraries
  178.  
  179. We are providing a few additional libraries for you to work with. One is
  180. a set of interesting demos developed at GWU; another is John Dalbey's
  181. Spider Graphics; still other is an adaptation of the Portable Ada Math
  182. Library. These are set up in separate subdirectories. A fourth
  183. subdirectory contains a lot of interesting Ada programs supplied by NYU
  184. as part of their distribution.
  185.  
  186. Ada/Ed requires that all units "with-ed" by a given main program be
  187. compiled into the same Ada library as the main, so the best way to use
  188. the math and graphics packages is to compile them into your program
  189. library as set up above. All you need to do to accomplish this is give
  190. the GW-Ada/Ed editor (or Ada/Ed) the full pathname, for example
  191. c:\adaed\math\math.ads, when you open the file. This way you can leave
  192. the source code in its own subdirectory without cluttering up your
  193. working directory.
  194.  
  195. Help with the Ada Language Reference Manual
  196.  
  197. Part of the GW-Ada/Ed environment is a help system that assists in searching
  198. the Ada Language Reference Manual. This hypertext-like navigational aid
  199. is accessed from the Help menu in GW-Ada/Ed. If you have a mouse driver
  200. installed, you can use it to select topics.
  201.  
  202. Templates in the Editor
  203.  
  204. We are experimenting with "templates" in the editor. Try selecting
  205. options from the "Ada" menu. Some of the templates are very
  206. straightforward control structures; others are "higher-level"
  207. structures. You can change the contents of the templates - they are all
  208. in .tpl files in the adaed directory. You can use any ASCII editor to
  209. change them. We are developing the idea of making the entire
  210. template-selection menu user-definable.
  211.  
  212. Package Completion
  213.  
  214. The package is a very important structure in Ada. To help you create
  215. packages easily, we have included in the editor a facility that will
  216. automatically create the skeleton of a package body once you have
  217. constructed and compiled the specification. See the user manual for
  218. further details.
  219.  
  220. Runtime Monitoring
  221.  
  222. This system incorporates some innovative facilities for letting you
  223. observe the behavior of your program as it executes. When you start
  224. executing a program, a window opens to show you its source code, and
  225. scrolls the code, line-by-line, during execution. You can also "single-
  226. step" through the code; pressing the space bar advances the execution
  227. one more line. In addition, if your program calls a subprogram, a window
  228. opens for the subprogram, overlapping the calling program's window.
  229. Finally, you can control the execution speed of your program with a
  230. "speed control."
  231.  
  232. If your program contains multiple Ada tasks, the runtime monitor will
  233. let you follow the execution of the various tasks as they are "time-
  234. shared". You can open up to four windows to show task source code. See
  235. the user manual for further details.
  236.  
  237. Known Problems with GW-Ada/Ed
  238.  
  239. (1) After doing repeated compile/bind/execute cycles, gwada may crash.
  240.     We think this is due to "storage leaks" - slowly running out of
  241.     memory - but we are not sure yet. Just re-start gwada and
  242.     keep working.
  243.  
  244. We are working actively on the integrated environment, and encourage you
  245. to submit suggestions and bug reports. However, you must realize that
  246. this is an educational project, operating with little or no funding.
  247. Therefore we cannot promise new versions or bug fixes. We'll do the best
  248. we can.
  249.  
  250. Possible Problems with Ada/Ed
  251.  
  252. Ada/Ed is a quite stable compiler/interpreter, and almost always
  253. compiles correct Ada code correctly. At GW we use Ada/Ed for our
  254. freshman-level Ada course because of its useful error messages, speed of
  255. compilation, and economy of disk space because only small pseudo-code
  256. files are created, never full executables. Overall, you will find it a
  257. very useful way to explore Ada without investing in a commercial
  258. compiler.
  259.  
  260. Incorrect code will almost always give rise to useful error diagnostics.
  261. Occasionally, incorrect programs with bizarre syntax or semantic errors
  262. will cause an "Ada/Ed Internal Error". If this happens, you will
  263. generally get a useful listing file anyway, so you can correct the
  264. errors and re-compile, writing off the crash to Ada/Ed bugs, of which
  265. there may still be some. In very unusual cases, Ada/Ed may crash on a
  266. correct but unusually-structured program.
  267.  
  268. Occasionally we may be able to fix a bug in Ada/Ed itself, but we are
  269. treating that system as stable and essentially frozen. Therefore we make
  270. no promises to debug Ada/Ed. For that matter, neither does NYU, as they
  271. are busy at work developing a true compiler for Ada 9X, to be
  272. distributed under the GNU Public License as part of the gcc
  273. distribution. They expect an initial release in 1993.
  274.  
  275. Keep in touch! Let us know how you like this system.
  276.  
  277. Disclaimer
  278.                                            
  279. This software is distributed absolutely WITHOUT ANY WARRANTY; without even 
  280. the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
  281. See the GNU General Public License for more details.
  282.  
  283. To receive a copy of the GNU General Public License write to the Free
  284. Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139.
  285.  
  286. The following is an excerpt from the GNU General Public License concerning
  287. warranties:
  288.  
  289. Because the program is licensed free of charge, there is no warranty
  290. for the program, to the extent permitted by applicable law.  Except when
  291. otherwise stated in writing the copyright holders and/or other parties
  292. provide the program "as is" without warranty of any kind, either expressed
  293. or implied, including, but not limited to, the implied warranties of
  294. merchantability and fitness for a particular purpose.  The entire risk as
  295. to the quality and performance of the program is with you.  Should the
  296. program prove defective, you assume the cost of all necessary servicing,
  297. repair or correction. 
  298.  
  299. In no event unless required by applicable law or agreed to in writing
  300. will any copyright holder, or any other party who may modify and/or
  301. redistribute the program as permitted above, be liable to you for damages,
  302. including any general, special, incidental or consequential damages arising
  303. out of the use or inability to use the program (including but not limited
  304. to loss of data or data being rendered inaccurate or losses sustained by
  305. you or third parties or a failure of the program to operate with any other
  306. programs), even if such holder or other party has been advised of the
  307. possibility of such damages.
  308.  
  309. Acknowledgement
  310.  
  311. This project was sponsored by The George Washington University, and in
  312. part by the United States Advanced Research Projects Agency (ARPA) under
  313. contract #FY3592-93-10234, administered by Phillips Laboratory, Kirtland
  314. AFB, NM 87117-5776.
  315.